Skip to content

Conversation

@teresalves
Copy link
Contributor

Summary

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 3, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Enhanced KV documentation to include bulk retrieval of key-value pairs.

  • Updated the get() method documentation to support multiple keys retrieval.
  • Added examples for fetching multiple keys and their responses.
  • Introduced getWithMetadata() method for retrieving values with associated metadata.

Modified Files

  • src/content/docs/kv/api/read-key-value-pairs.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@thomasgauvin thomasgauvin marked this pull request as ready for review April 4, 2025 13:32
"typescript.tsdk": "node_modules/typescript/lib",
"cSpell.enableFiletypes": ["mdx"],
"files.associations": { "__redirects": "plaintext", "_headers": "plaintext" }
"files.associations": { "__redirects": "plaintext", "_headers": "plaintext", "*.mdx": "markdown" },
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this an intentional change? I don't actually know what this does.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was me, I was having some issues rendering the mdx files locally. Reverted it :)

@thomasgauvin
Copy link
Contributor

There is not enough size difference between #### and ##### @Oxyjun @KianNH. Any chance we can increase the font size for ####?

@Oxyjun
Copy link
Contributor

Oxyjun commented Apr 8, 2025

There is not enough size difference between #### and ##### @Oxyjun @KianNH. Any chance we can increase the font size for ####?

You're right that the size difference isn't big between H4 and H5. I can raise this for discussion within the team :D

FYI, as a general rule of thumb, we want to avoid H4s and lower - at that level of granularity of headings, users might not find the heading hierarchy very useful. If you have a single page which warrants H5s, I would recommend creating a new chapter it?

@thomasgauvin
Copy link
Contributor

thomasgauvin commented Apr 15, 2025

There is not enough size difference between #### and ##### @Oxyjun @KianNH. Any chance we can increase the font size for ####?

You're right that the size difference isn't big between H4 and H5. I can raise this for discussion within the team :D

FYI, as a general rule of thumb, we want to avoid H4s and lower - at that level of granularity of headings, users might not find the heading hierarchy very useful. If you have a single page which warrants H5s, I would recommend creating a new chapter it?

Only going as low as H4 and H5 because it starts at H2

date: 2025-04-17T14:00:00Z
---

You can now retrieve up to 100 keys in a single bulk read request made to Workers KV.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thomasgauvin This feels like it's missing the broader context. Workers supports several programming languages, but this solution is only in JavaScript throughout the docs. Is that the only platform it works on? I noticed that the REST API supports bulk reads. Curious if the other platforms should use that?

Copy link
Contributor

@thomasgauvin thomasgauvin Apr 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jhutchings1 We don't have documentation for Python or Rust bindings. Adjusted to mention this is for bindings!

@thomasgauvin thomasgauvin merged commit 1dbf2de into cloudflare:production Apr 17, 2025
7 checks passed
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* KV: add bulk gets documentation

* PCX review

* Update src/content/docs/kv/api/read-key-value-pairs.mdx

* Update src/content/docs/kv/api/read-key-value-pairs.mdx

* Update src/content/docs/kv/api/read-key-value-pairs.mdx

* Update src/content/docs/kv/api/read-key-value-pairs.mdx

* Update src/content/docs/kv/api/read-key-value-pairs.mdx

* checking perms

* wip

* fix: delete changes to settings.json file

* adjust changelog

* Update .vscode/settings.json

* fix styling, missing differentiation between h4 and h5

* Update src/content/changelog/kv/2025-04-10-kv-bulk-reads.mdx

---------

Co-authored-by: talves <[email protected]>
Co-authored-by: Jun Lee <[email protected]>
Co-authored-by: Thomas Gauvin <[email protected]>
Co-authored-by: Thomas Gauvin <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants